home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / dev / c / mkid.lha / doc / lid.man < prev    next >
Text File  |  1995-06-29  |  5KB  |  151 lines
  1.  
  2.  
  3. LID(1)                     Unix Programmer's Manual                     LID(1)
  4.  
  5.  
  6. NAME
  7.      lid, gid, eid - query id database
  8.  
  9. SYNOPSIS
  10.      lid [-ffile] [-un] [-edoxamse] patterns...
  11.  
  12.      gid [-ffile] [-edoxamse] patterns...
  13.  
  14.      eid [-ffile] [-doxamse] patterns...
  15.  
  16.      aid [-ffile] [-doxams] patterns...
  17.  
  18. DESCRIPTION
  19.      These commands provide a flexible query interface  to  the  id  database.
  20.                                                                  --
  21.      Lid does a lookup on patters and prints out lines in this way:
  22.      ---                  -------
  23.  
  24.      idname        ../hdir/hfile.h ../cdir/{cfile1,cfile2}.c
  25.  
  26.      Notice that multiple files with the same directory prefix and suffix  are
  27.      concatenated  in  the  globbing-set-notation of csh(1).  Also notice that
  28.                                                      ---
  29.      all of the id database query commands adjust the list of pathnames to  be
  30.                 --
  31.      relative  to  your  current  working directory, provided that mkid(1) was
  32.                                                                    ----
  33.      used to build the database, and your working directory is located  within
  34.      the sub-tree covered by the id database.
  35.                                  --
  36.  
  37.      If multiple names match on pattern, then there will be one line of output
  38.      per name.  The mnemonic significance of the name is l(ookup) id.
  39.                                                          - -----  --
  40.  
  41.      Gid does a lookup and then searches for the names it matches in the files
  42.      ---
  43.      where they occur.  The mnemonic for this name is g(rep)id.
  44.                                                       - --- --
  45.  
  46.      Eid does a lookup, and then invokes an  editor  on  all  files  with  the
  47.      ---
  48.      matched  name  as  an initial search string.  Of course, this name stands
  49.      for e(dit) id.
  50.          - ---  --
  51.  
  52.      Eid uses four environment variables to  control  its  invocation  of  the
  53.      ---
  54.      editor.  Naturally, EDITOR is used to locate the editing program.  EIDARG
  55.      is a printf(3S) string used to specify the form  of  the  initial-search-
  56.           ------
  57.      string  argument.   If the editor does not support such an argument, this
  58.      variable may be left unset.  EIDLDEL and EIDRDEL specify the form of  the
  59.      left and right word-delimiters respectively.  The best way to explain the
  60.      use of these last three variables is  with  an  example.   Here  are  the
  61.      proper settings for vi(1):
  62.      EIDARG='+/%s/' # initial search argument template
  63.      EIDLDEL='\<' # left word-delimiter
  64.      EIDRDEL='\>' # right word-delimiter
  65.  
  66.      Patterns may be simple alpha-numeric strings, or regular  expressions  in
  67.      --------
  68.      the  style  of  regcmp(3).   If the string contains no regular-expression
  69.                      ------
  70.      meta-characters, it is searched for as a word.  If  the  string  contains
  71.                                               ----
  72.      meta-characters, or if the -e argument is supplied, it is searched for as
  73.      regular-expression.
  74.  
  75.      Aid produces output in the style of lid but  its  pattern  arguments  are
  76.      ---                                 ---
  77.      searched  for  as  substrings within the identifiers in the database.  No
  78.      regular-expression search is performed,  even  if  the  pattern  contains
  79.  
  80.  
  81.                                                                              1
  82.  
  83.  
  84.  
  85. LID(1)                     Unix Programmer's Manual                     LID(1)
  86.  
  87.  
  88.      meta-characters.   The  search  is  conducted  in  an   alphabetic   case
  89.      insensitive manner.  The mnemonic for this name is a(propos) id.
  90.                                                         - ------  --
  91.  
  92.      The following options are recognized:
  93.  
  94.      -ffile    Use file as the database instead of the default ID.
  95.                    ----
  96.  
  97.      -un       Lists all identifiers  in  the  database  that  are  non-unique
  98.                within  the  first n characters.  This facility is particularly
  99.                                   -
  100.                helpful when porting a program to a system  whose  compiler  or
  101.                linker has fewer significant characters for identifiers.
  102.  
  103.      The remaining options are for use in conjunction with numeric patterns:
  104.  
  105.      -doxa     These options may be specified in any combination.  They  limit
  106.                numeric  matches  to  specific  radixes.   The  -d,  -o, and -x
  107.                options  limit  matches  to  decimal,  octal,  and  hexadecimal
  108.                respectively.   The -a option is a shorthand for specifying all
  109.                three radixes.
  110.  
  111.      Searches for numbers are conducted numerically rather than lexically,  so
  112.      that  all  representations  for  a given number are potentially available
  113.      from a single search.
  114.  
  115.      -m        Merge multiple lines of output into a single line.
  116.  
  117.      -s        Limit the results of the search to identifiers that occur  only
  118.                once  in  the  entire  set  of sources covered by the database.
  119.                This option is useful for finding identifiers that are  defined
  120.                but never used.
  121.  
  122. SEE ALSO
  123.      mkid(1), fid(1).
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.                                                                              2
  150.  
  151.